pygments: add typing annotation for missing base files of pygments #14832
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lev-blit
force-pushed
the
feature/pygments-fill-typing
branch
from
ec07b24 to
b3485bd
Compare
This comment has been minimized.
This comment has been minimized.
lev-blit
force-pushed
the
feature/pygments-fill-typing
branch
from
c670fec to
657943f
Compare
This comment has been minimized.
This comment has been minimized.
|
Diff from mypy_primer, showing the effect of this PR on open source code: pwndbg (https://github.com/pwndbg/pwndbg)
+ pwndbg/integration/binja.py: note: In member "decompile" of class "BinjaProvider":
+ pwndbg/integration/binja.py:503: error: No overload variant of "format" matches argument types "list[tuple[Any, str]]", "Terminal256Formatter[str]" [call-overload]
+ pwndbg/integration/binja.py:503: note: Possible overload variants:
+ pwndbg/integration/binja.py:503: note: def [_T: (str, bytes)] format(tokens: Iterator[tuple[_TokenType, str]], formatter: Formatter[_T], outfile: SupportsWrite[_T]) -> None
+ pwndbg/integration/binja.py:503: note: def [_T: (str, bytes)] format(tokens: Iterator[tuple[_TokenType, str]], formatter: Formatter[_T], outfile: None = ...) -> _T
+ pwndbg/integration/binja.py:509: error: No overload variant of "format" matches argument types "list[tuple[Any, str]]", "Terminal256Formatter[str]" [call-overload]
+ pwndbg/integration/binja.py:509: note: Possible overload variants:
+ pwndbg/integration/binja.py:509: note: def [_T: (str, bytes)] format(tokens: Iterator[tuple[_TokenType, str]], formatter: Formatter[_T], outfile: SupportsWrite[_T]) -> None
+ pwndbg/integration/binja.py:509: note: def [_T: (str, bytes)] format(tokens: Iterator[tuple[_TokenType, str]], formatter: Formatter[_T], outfile: None = ...) -> _T
sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/highlighting.py:39: error: Unused "type: ignore" comment [unused-ignore]
+ sphinx/highlighting.py:39:5: error: Cannot assign to a method [method-assign]
+ sphinx/highlighting.py:39:5: note: Error code "method-assign" not covered by "type: ignore" comment
+ sphinx/highlighting.py:39:35: error: Incompatible types in assignment (expression has type "classmethod[Any, [Any], Any]", variable has type "Callable[[Any], GenericAlias]") [assignment]
+ sphinx/highlighting.py:39:35: note: Error code "assignment" not covered by "type: ignore" comment
alectryon (https://github.com/cpitclaudel/alectryon)
+ alectryon/pygments_lexer.py:456: error: Dict entry 3 has incompatible type "str": "list[tuple[str | Any, ...]]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
+ alectryon/pygments_lexer.py:457: error: Dict entry 4 has incompatible type "str": "list[tuple[str | Any, ...]]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
+ alectryon/pygments_lexer.py:477: error: Dict entry 7 has incompatible type "str": "list[object]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
+ alectryon/pygments_lexer.py:490: error: Dict entry 9 has incompatible type "str": "list[object]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
+ alectryon/pygments_lexer.py:491: error: Dict entry 10 has incompatible type "str": "list[object]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
+ alectryon/pygments_lexer.py:492: error: Dict entry 11 has incompatible type "str": "list[object]"; expected "str": "list[tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]]] | tuple[str | words, _TokenType | Iterator[tuple[int, _TokenType, str]] | Callable[[Lexer, _PseudoMatch, LexerContext], Iterator[tuple[int, _TokenType, str]]], str] | include | default]" [dict-item]
|
srittau
reviewed
Oct 7, 2025
| def find_filter_class(filtername): ... | ||
| def get_filter_by_name(filtername, **options): ... | ||
| def find_filter_class(filtername: str) -> type[Filter]: ... | ||
| def get_filter_by_name(filtername: str, **options: Any) -> Filter: ... |
There was a problem hiding this comment.
Also applies to the other **options: Any annotations in this PR: In general, when using Any we need a comment, explaining the possible types or reason for using it. In this case probably something like this:
Suggested change
| def get_filter_by_name(filtername: str, **options: Any) -> Filter: ... | |
| # options are forwarded to the filter's constructor | |
| def get_filter_by_name(filtername: str, **options: Any) -> Filter: ... |
See https://typing.python.org/en/latest/guides/writing_stubs.html#using-any-and-object for details.
| def get_formatter_by_name(_alias, **options): ... | ||
| def load_formatter_from_file(filename, formattername: str = "CustomFormatter", **options): ... | ||
| def get_formatter_for_filename(fn, **options): ... | ||
| def find_formatter_class(alias: str) -> type[Formatter[Any]]: ... |
There was a problem hiding this comment.
In this case, Formatter[Any] doesn't need an explanation, as it's obvious why it's used.
Comment on lines
+108
to
+117
| tokendefs: ( | ||
| dict[ | ||
| str, | ||
| list[ | ||
| tuple[str, _TokenType | Iterator[tuple[int, _TokenType, str]]] | ||
| | tuple[str, _TokenType | Iterator[tuple[int, _TokenType, str]], str] | ||
| ], | ||
| ] | ||
| | None | ||
| ) = None, |
There was a problem hiding this comment.
I haven't looked at this in detail, but this could be problematic. Due to the invariance of list, this will reject calls like this:
x.process_tokendef("", {"foo": [("", "")]})In this case, the dict could be inferred to have type dict[str, list[tuple[str, str]]], but list[tuple[str, str]] is incompatible with list[tuple[str, str, str]].
Same below.
Comment on lines
+37
to
+38
| def guess_decode_from_terminal(text: bytes, term: TextIO | Any) -> tuple[bytes, str]: ... | ||
| def terminal_encoding(term: TextIO | Any) -> str: ... |
There was a problem hiding this comment.
Pseudo-protocols like TextIO should be avoided. In this case, we could use a protocol _HasEncoding or similar, but I think the better approach is to just use Any with a comment:
Suggested change
| def guess_decode_from_terminal(text: bytes, term: TextIO | Any) -> tuple[bytes, str]: ... | |
| def terminal_encoding(term: TextIO | Any) -> str: ... | |
| # In the following two methods, `term` are file-like objects that optionally have an | |
| # `encoding` attribute. | |
| def guess_decode_from_terminal(text: bytes, term: Any) -> tuple[bytes, str]: ... | |
| def terminal_encoding(term: Any) -> str: ... |
This would be another good use case for python/typing#601.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.